4.7.1 查询认证服务器列表

基本信息

Path: /api/v1/authServer/queryAll

Method: GET

接口描述:

说明

鉴于认证服务器参数的复杂程度较高,且创建好后相关配置变动的概率较小,当前暂不对外提供认证服务器的新增、编辑和删除接口。

请求参数

Query

参数名称 是否必须 示例 备注
pageSize 非必须 20 每页数据数目
pageIndex 非必须 1 当前页 从1开始
filter 非必须 name 过滤条件,只能从 ['all', 'name', 'description']中选择。不传或者传空表示不添加过滤条件,即查询全部。
searchValue 非必须 test 搜索关键字,不传或者传空表示不添加过滤条件,即查询全部
sortBy 非必须 排序字段
asc 非必须 排序方式,1升序,0降序,默认升序
isPage 非必须 '0'不需要分页,'1' 需要分页

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须 返回编码 0 成功 其它值,失败
data object 非必须 数据主体
├─ data object [] 非必须 认证服务器列表,数组对象 item 类型: object
├─ ├─ id string 必须 主键
├─ ├─name string 必须 认证服务名称
├─ ├─authType string 必须 认证类型
├─ ├─subtype string 必须 认证子类型 示例:ldap
├─ ├─status number 必须 认证状态
├─ ├─authGroup string 必须 认证所属组
├─ ├─description string 必须 描述
├─ ├─loginDomain string 必须 登录认证域
├─ ├─config object 必须 认证服务器配置
├─ ├─ ├─userDirectory object 必须 认证服务器绑定的用户目录
├─ ├─ ├─ ├─id string 必须 用户目录 id
├─ ├─ ├─ ├─name string 必须 用户目录名称
├─ count number 非必须 数据总数
├─ pageIndex number 非必须 当前页码,从1开始
├─ pageSize number 非必须 分页大小,默认20
├─ pageCount number 非必须 分页数
msg string 非必须 code对应的提示信息  

返回示例

{
    "code": 0,
    "data": {
        "pageSize": 20,
        "pageIndex": 1,
        "count": 2,
        "pageCount": 1,
        "data": [{
            "id": "d36291f0-596a-11eb-a393-bbd9cb0893d1",
            "status": 1,
            "name": "11",
            "description": "",
            "authType": "auth/psw",
            "subtype": "radiusAccount",
            "authGroup": "PrimaryAuth",
            "loginDomain": "radius.com",
            "config": {
                "userDirectory": {
                    "id": "ada6aac0-8bb3-11eb-9057-3f8c302f3ab6",
                    "name": "radius-user-directory",
                }
            },
        }, {
            "id": "1",
            "status": 1,
            "name": "本地密码认证",
            "description": "",
            "domain": "local",
            "authType": "auth/psw",
            "subtype": "default",
            "authGroup": "PrimaryAuth",
            "loginDomain": "local",
            "config": {
                "userDirectory": {
                    "id": "1",
                    "name": "本地密码认证",
                }
            },
        }],
    },
    "msg": "请求成功"
}

错误信息

错误提示 错误码
不支持的搜索内容 7201
不支持的排序内容 7201
查询认证服务器失败 37400007
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-11-20 11:03

results matching ""

    No results matching ""